home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / caterr.z / caterr
Text File  |  1998-10-20  |  11KB  |  191 lines
  1. CATERR(1)                       UNICOS 10.0           Last changed: 3-26-98
  2.  
  3.  
  4. NNAAMMEE
  5.      ccaatteerrrr - Processes message text files
  6.  
  7. SSYYNNOOPPSSIISS
  8.      ccaatteerrrr [--cc _c_a_t_f_i_l_e] [--ee] [--ss[--PP _c_p_p__o_p_t_s]] [--YY _x,,_p_a_t_h_n_a_m_e] [_m_s_g_f_i_l_e]
  9.  
  10. IIMMPPLLEEMMEENNTTAATTIIOONN
  11.      UNICOS systems
  12.  
  13.      IRIX systems
  14.  
  15. DDEESSCCRRIIPPTTIIOONN
  16.      A _m_e_s_s_a_g_e _c_a_t_a_l_o_g is a binary file that contains the run-time source
  17.      of error messages output by UNICOS software products.  A message
  18.      catalog is produced from a message text file that contains messages
  19.      (tagged with $$mmssgg tags) and message explanations (tagged with $$nneexxpp or
  20.      $$eexxpp tags).
  21.  
  22.      Before it can be accessed at run time, a message text file must be
  23.      converted to a message catalog binary file by the ccaatteerrrr processor and
  24.      the ggeennccaatt(1) catalog generator.
  25.  
  26.      The ccaatteerrrr utility converts the error message text source in _m_s_g_f_i_l_e
  27.      into the format used as input to ggeennccaatt(1), the error message catalog
  28.      generation utility.  If _m_s_g_f_i_l_e is not specified or if a dash (--) is
  29.      specified, ccaatteerrrr reads from the standard input.
  30.  
  31.      The --cc option to the ccaatteerrrr utility calls ggeennccaatt(1) after processing
  32.      is complete.  Using the --cc option allows a catalog to be generated
  33.      from a message text file in one step.  It is recommended that you use
  34.      ccaatteerrrr with the --cc option.  The ggeennccaatt(1) utility exists as a separate
  35.      utility to maintain compatibility with industry standards for message
  36.      catalog processing.  No advantage exists in calling ggeennccaatt(1)
  37.      separately.  By default, ccaatteerrrr looks for ggeennccaatt(1) in the
  38.      //uussrr//bbiinn//ggeennccaatt file.
  39.  
  40.      A single invocation of ccaatteerrrr can process either the messages or the
  41.      explanations in the input files, but not both.  The ccaatteerrrr utility
  42.      processes the messages by default.  Use the --ee option to specify
  43.      processing of the explanations.
  44.  
  45.      The ccaatteerrrr utility calls the text formatting utility nnrrooffff(1) to
  46.      process formatted explanations as part of its processing of the
  47.      message text file.  nnrrooffff(1) uses message macro definitions to format
  48.      the explanation text.  By default, on UNICOS systems, ccaatteerrrr looks for
  49.      nnrrooffff(1) in the //uussrr//bbiinn//nnrrooffff file and for the message macros in the
  50.      //uussrr//lliibb//ttmmaacc//ttmmaacc..ssgg file.  On IRIX systems, ccaatteerrrr looks for
  51.      nnrrooffff(1) in the //uussrr//bbiinn//nnrrooffff file and for the message macros in the
  52.      //uussrr//sshhaarree//lliibb//ttmmaacc//ttmmaacc..ssgg file.
  53.  
  54.      If no options are specified, ccaatteerrrr processes _m_s_g_f_i_l_e by using the
  55.      tools in the default locations.  The output, suitable for input to
  56.      ggeennccaatt(1), is sent to ssttddoouutt.
  57.  
  58.      The ccaatteerrrr utility accepts the following options and arguments:
  59.  
  60.      --cc _c_a_t_f_i_l_e
  61.                (Catalog) Calls ggeennccaatt(1) to update or create a catalog with
  62.                the information in the processed _m_s_g_f_i_l_e.  If the --cc option
  63.                is used, ccaatteerrrr invokes ggeennccaatt(1) to update the specified
  64.                catalog by using the generated output.  If _c_a_t_f_i_l_e does not
  65.                exist, it is created.  Using the --cc option makes it
  66.                unnecessary to call ggeennccaatt(1) separately; the message
  67.                catalog is generated in one step.
  68.  
  69.      --ee        (Explanations) Processes the explanations in _m_s_g_f_i_l_e.
  70.                Without the --ee option, ccaatteerrrr processes the messages in
  71.                _m_s_g_f_i_l_e.
  72.  
  73.      --ss[--PP _c_p_p__o_p_t_s]
  74.                (Symbolic names) Calls the C language preprocessor (ccpppp(1))
  75.                to preprocess symbolic message names into message numbers.
  76.                The mapping of names to numbers must be specified in a
  77.                header file name in the input file.  On UNICOS systems,
  78.                ccaatteerrrr looks for ccpppp(1) first in the //uussrr//ggeenn//lliibb//ccpppp
  79.                directory.  If it does not find it there, it looks in
  80.                //lliibb//ccpppp.  On IRIX systems, ccaatteerrrr looks for ccpppp(1) in the
  81.                //lliibb//ccpppp directory.
  82.  
  83.                Options can be passed to ccpppp by specifying the --PP suboption
  84.                to the --ss option.  Place the options to be passed to ccpppp
  85.                within double quotation marks ("" "").  The entire string
  86.                within the quotation marks is passed to ccpppp for execution.
  87.                The --PP suboption can be specified only if the --ss option also
  88.                is specified.
  89.  
  90.      --YY _x,,_p_a_t_h_n_a_m_e
  91.                Specifies the version of the nnrrooffff(1) and ggeennccaatt(1) tools
  92.                and of the ttmmaacc..ssgg message macros that ccaatteerrrr calls.  If the
  93.                --YY option is not specified, ccaatteerrrr calls the version of
  94.                nnrrooffff(1) in //uussrr//bbiinn//nnrrooffff, the version of ggeennccaatt(1) in
  95.                //uussrr//bbiinn//ggeennccaatt, and the version of the message macros in
  96.                //uussrr//lliibb//ttmmaacc//ttmmaacc..ssgg (UNICOS systems) or
  97.                //uussrr//sshhaarree//lliibb//ttmmaacc//ttmmaacc..ssgg (IRIX systems).  If you need to
  98.                specify alternative paths for all three tools that ccaatteerrrr
  99.                calls, you can specify the --YY option up to three times in
  100.                the same command line.
  101.  
  102.                The --YY option takes two arguments:  a path name and a key
  103.                letter that specifies which software (nnrrooffff(1), ggeennccaatt(1),
  104.                or the message macros) is located at that path name.  The
  105.                key letter is specified first, followed by a comma (,,),
  106.                followed by the path name.  The alternative tool path
  107.                specified with _p_a_t_h_n_a_m_e must be a full path.
  108.  
  109.                The --YY option accepts the following key letters:
  110.  
  111.                cc    Specifies that the path name following the comma is the
  112.                     path name for ggeennccaatt(1).
  113.  
  114.                mm    Specifies that the path name following the comma is the
  115.                     path name for the message macros.
  116.  
  117.                nn    Specifies that the path name following the comma is the
  118.                     path name for nnrrooffff(1).
  119.  
  120.      _m_s_g_f_i_l_e   Specifies the name of the file containing the message text
  121.                source to be processed.
  122.  
  123. EEXXAAMMPPLLEESS
  124.      Example 1:  In the following example, ccaatteerrrr processes the messages in
  125.      file llddrr..mmssgg.  The output, sent to ssttddoouutt, is suitable for input to
  126.      ggeennccaatt(1).
  127.  
  128.           caterr ldr.msg
  129.  
  130.      Example 2:  In the following example, ccaatteerrrr invokes ggeennccaatt(1) to
  131.      update the messages in the llddrr..ccaatt catalog with the information in
  132.      file llddrr..mmssgg.
  133.  
  134.           caterr -c ldr.cat ldr.msg
  135.  
  136.      Example 3:  In the following example, ccaatteerrrr uses the message macros
  137.      in the file //uussrr//mmee//eerrrrmmssgg//ttmmaacc..ssgg to produce a catalog of
  138.      explanations suitable for processing by ggeennccaatt(1).  The input file is
  139.      llddrr..mmssgg; the output is sent to ssttddoouutt.
  140.  
  141.           caterr -e -Y m,/usr/me/errmsg/tmac.sg ldr.msg
  142.  
  143.      Example 4:  In the following example, ccaatteerrrr uses the message macros
  144.      in the current directory and invokes ggeennccaatt(1) from //bbiinn//ggeennccaatt to
  145.      update the explanation catalog llddrr..eexxpp with the information in
  146.      llddrr..mmssgg.
  147.  
  148.           caterr -e -c ldr.exp -Y m,tmac.sg -Y c,/bin/gencat ldr.msg
  149.  
  150.      Example 5:  In the following example, ccaatteerrrr calls nnrrooffff from
  151.      //uussrr//mmee//eerrrrmmssgg//nnrrooffff and uses the message macros in the current
  152.      directory.  The input file is llddrr..mmssgg.  Explanations suitable for
  153.      processing by ggeennccaatt(1) are output to ssttddoouutt.
  154.  
  155.           caterr -e -Y n,/usr/me/errmsg/nroff -Y m,tmac.sg ldr.msg
  156.  
  157.      Example 6:  In the following example, ccaatteerrrr calls alternative
  158.      versions of all three tools.  It uses the versions of nnrrooffff(1) and the
  159.      message macros in the current directory, and it calls ggeennccaatt(1) from
  160.      //bbiinn//ggeennccaatt.  Using these tools, the explanations in the llddrr..eexxpp file
  161.      are updated with the information in the llddrr..mmssgg file.
  162.  
  163.       caterr -e -c ldr.exp -Y c,/bin/gencat -Y m,tmac.sg -Y n,nroff ldr.msg
  164.  
  165.      Example 7:  In the following example, ccaatteerrrr invokes ggeennccaatt(1) to
  166.      update the messages in the llddrr..ccaatt catalog with the information in the
  167.      llddrr..mmssgg file.  The ccaatteerrrr utility calls ccpppp(1) to preprocess symbolic
  168.      message names, and passes the --MM option to ccpppp(1) for execution.
  169.  
  170.           caterr -c ldr.cat -s -P "-M" ldr.msg
  171.  
  172.      Example 8:  In the following example, ccaatteerrrr invokes ggeennccaatt(1) to
  173.      update the llddrr..ccaatt catalog.  Because no message text file name is
  174.      specified, the input to ccaatteerrrr is read from the standard input.
  175.  
  176.           caterr -c ldr.cat
  177.  
  178. SSEEEE AALLSSOO
  179.      eexxppllaaiinn(1), ggeennccaatt(1), wwhhiicchhccaatt(1)
  180.  
  181.      ccaattggeettmmssgg(3C), ccaattggeettss(3C), ccaattmmssggffmmtt(3C), ccaattooppeenn(3C) in the _U_N_I_C_O_S
  182.      _S_y_s_t_e_m _L_i_b_r_a_r_i_e_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2080
  183.  
  184.      nnll__ttyyppeess(5), mmssgg(7D) in the _U_N_I_C_O_S _F_i_l_e _F_o_r_m_a_t_s _a_n_d _S_p_e_c_i_a_l _F_i_l_e_s
  185.      _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2014
  186.  
  187.      _C_r_a_y _M_e_s_s_a_g_e _S_y_s_t_e_m _P_r_o_g_r_a_m_m_e_r'_s _G_u_i_d_e, publication SG-2121
  188.  
  189.      _U_N_I_C_O_S _U_s_e_r _C_o_m_m_a_n_d_s _R_e_f_e_r_e_n_c_e _M_a_n_u_a_l, publication SR-2011, for the
  190.      printed version of this man page.
  191.